docs: add docs for GtkDirectionType and GtkDeleteType
authorWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 21 Jan 2014 16:31:21 +0000 (11:31 -0500)
committerWilliam Jon McCann <william.jon.mccann@gmail.com>
Tue, 21 Jan 2014 18:33:46 +0000 (13:33 -0500)
gtk/gtkenums.h

index 631a2a3da6aa116f89265365e46d5c7ecb2204ab..69b106ebdb9d42f97b82f37476f51940349479d1 100644 (file)
@@ -178,6 +178,25 @@ typedef enum
 } GtkButtonBoxStyle;
 
 
+/**
+ * GtkDeleteType:
+ * @GTK_DELETE_CHARS: Delete characters.
+ * @GTK_DELETE_WORD_ENDS: Delete only the portion of the word to the
+ *   left/right of cursor if we're in the middle of a word.
+ * @GTK_DELETE_WORDS: Delete words.
+ * @GTK_DELETE_DISPLAY_LINES: Delete display-lines. Display-lines
+ *   refers to the visible lines, with respect to to the current line
+ *   breaks. As opposed to paragraphs, which are defined by line
+ *   breaks in the input.
+ * @GTK_DELETE_DISPLAY_LINE_ENDS: Delete only the portion of the
+ *   display-line to the left/right of cursor.
+ * @GTK_DELETE_PARAGRAPH_ENDS: Delete to the end of the
+ *   paragraph. Like C-k in Emacs (or its reverse).
+ * @GTK_DELETE_PARAGRAPHS: Delete entire line. Like C-k in pico.
+ * @GTK_DELETE_WHITESPACE: Delete only whitespace. Like M-\ in Emacs.
+ *
+ * See also: #GtkEntry::delete-from-cursor.
+ */
 typedef enum
 {
   GTK_DELETE_CHARS,
@@ -193,6 +212,17 @@ typedef enum
 } GtkDeleteType;
 
 /* Focus movement types */
+/**
+ * GtkDirectionType:
+ * @GTK_DIR_TAB_FORWARD: Move forward.
+ * @GTK_DIR_TAB_BACKWARD: Move backward.
+ * @GTK_DIR_UP: Move up.
+ * @GTK_DIR_DOWN: Move down.
+ * @GTK_DIR_LEFT: Move left.
+ * @GTK_DIR_RIGHT: Move right.
+ *
+ * Focus movement types.
+ */
 typedef enum
 {
   GTK_DIR_TAB_FORWARD,